<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MgrFavorites: GdaBrowser hacking manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GdaBrowser hacking manual">
<link rel="up" href="perspectives.html" title="Perspectives' objects">
<link rel="prev" href="perspectives.html" title="Perspectives' objects">
<link rel="next" href="gda-browser-Schema-Browser-perspective.html" title="Schema Browser perspective">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#MgrFavorites.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#MgrFavorites.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#MgrFavorites.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="perspectives.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="perspectives.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gda-browser-Schema-Browser-perspective.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="MgrFavorites"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MgrFavorites.top_of_page"></a>MgrFavorites</span></h2>
<p>MgrFavorites — A <span class="type">GdaTreeManager</span> for the stored favorites</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="MgrFavorites.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="MgrFavorites.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<span class="returnvalue">GdaTreeManager</span> *
</td>
<td class="function_name">
<a class="link" href="MgrFavorites.html#mgr-favorites-new" title="mgr_favorites_new ()">mgr_favorites_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MgrFavorites.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a class="link" href="BrowserConnection.html" title="BrowserConnection"><span class="type">BrowserConnection</span></a> *</td>
<td class="property_name"><a class="link" href="MgrFavorites.html#MgrFavorites--browser-connection" title="The “browser-connection” property">browser-connection</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MgrFavorites.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="MgrFavorites.html#MgrFavorites-struct" title="struct MgrFavorites">MgrFavorites</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="MgrFavorites.html#MGR-FAVORITES-NAME-ATT-NAME:CAPS" title="MGR_FAVORITES_NAME_ATT_NAME">MGR_FAVORITES_NAME_ATT_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="MgrFavorites.html#MGR-FAVORITES-CONTENTS-ATT-NAME:CAPS" title="MGR_FAVORITES_CONTENTS_ATT_NAME">MGR_FAVORITES_CONTENTS_ATT_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="MgrFavorites.html#MGR-FAVORITES-ID-ATT-NAME:CAPS" title="MGR_FAVORITES_ID_ATT_NAME">MGR_FAVORITES_ID_ATT_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="MgrFavorites.html#MGR-FAVORITES-TYPE-ATT-NAME:CAPS" title="MGR_FAVORITES_TYPE_ATT_NAME">MGR_FAVORITES_TYPE_ATT_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="MgrFavorites.html#MGR-FAVORITES-POSITION-ATT-NAME:CAPS" title="MGR_FAVORITES_POSITION_ATT_NAME">MGR_FAVORITES_POSITION_ATT_NAME</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MgrFavorites.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GdaTreeManager
        <span class="lineart">╰──</span> MgrFavorites
</pre>
</div>
<div class="refsect1">
<a name="MgrFavorites.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="MgrFavorites.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="mgr-favorites-new"></a><h3>mgr_favorites_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GdaTreeManager</span> *
mgr_favorites_new (<em class="parameter"><code><a class="link" href="BrowserConnection.html" title="BrowserConnection"><span class="type">BrowserConnection</span></a> *bcnc</code></em>,
                   <em class="parameter"><code><span class="type">ToolsFavoritesType</span> type</code></em>,
                   <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> order_key</code></em>);</pre>
<p>Creates a new <span class="type">GdaTreeManager</span> object which will add one tree node for each favorite of the <em class="parameter"><code>type</code></em>
 type</p>
<div class="refsect3">
<a name="mgr-favorites-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>bcnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="BrowserConnection.html" title="BrowserConnection"><span class="type">BrowserConnection</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>the type of favorites to handle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>order_key</p></td>
<td class="parameter_description"><p>ordering key, see <code class="function">gda_tools_favorites_add()</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="mgr-favorites-new.returns"></a><h4>Returns</h4>
<p> a new <span class="type">GdaTreeManager</span> object</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="MgrFavorites.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MgrFavorites-struct"></a><h3>struct MgrFavorites</h3>
<pre class="programlisting">struct MgrFavorites;</pre>
</div>
<hr>
<div class="refsect2">
<a name="MGR-FAVORITES-NAME-ATT-NAME:CAPS"></a><h3>MGR_FAVORITES_NAME_ATT_NAME</h3>
<pre class="programlisting">#define MGR_FAVORITES_NAME_ATT_NAME "fav_name"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="MGR-FAVORITES-CONTENTS-ATT-NAME:CAPS"></a><h3>MGR_FAVORITES_CONTENTS_ATT_NAME</h3>
<pre class="programlisting">#define MGR_FAVORITES_CONTENTS_ATT_NAME "fav_contents"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="MGR-FAVORITES-ID-ATT-NAME:CAPS"></a><h3>MGR_FAVORITES_ID_ATT_NAME</h3>
<pre class="programlisting">#define MGR_FAVORITES_ID_ATT_NAME "fav_id"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="MGR-FAVORITES-TYPE-ATT-NAME:CAPS"></a><h3>MGR_FAVORITES_TYPE_ATT_NAME</h3>
<pre class="programlisting">#define MGR_FAVORITES_TYPE_ATT_NAME "fav_type"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="MGR-FAVORITES-POSITION-ATT-NAME:CAPS"></a><h3>MGR_FAVORITES_POSITION_ATT_NAME</h3>
<pre class="programlisting">#define MGR_FAVORITES_POSITION_ATT_NAME "fav_pos"
</pre>
</div>
</div>
<div class="refsect1">
<a name="MgrFavorites.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MgrFavorites--browser-connection"></a><h3>The <code class="literal">“browser-connection”</code> property</h3>
<pre class="programlisting">  “browser-connection”       <a class="link" href="BrowserConnection.html" title="BrowserConnection"><span class="type">BrowserConnection</span></a> *</pre>
<p>Connection to use.</p>
<p>Owner: MgrFavorites</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>